---
layout: m1x_soap
title: Balance Remove Amount
---

<h3><a name="storecredit_quote.removeAmount-Module%3ACustomerBalanceQuoteAPI"></a>Module: Customer Balance Quote API</h3>


<h4><a name="storecredit_quote.removeAmount-enterprisecustomerbalancequote"></a>enterprise_customerbalance_quote</h4>

<h5><a name="storecredit_quote.removeAmount-Aliases%3Astorecreditquote"></a>Aliases: storecredit_quote</h5>

<h5><a name="storecredit_quote.removeAmount-Method%3A"></a>Method:</h5>

<ul>
	<li>enterprise_customerbalance_quote.removeAmount (SOAP V1)</li>
	<li>shoppingCartCustomerbalanceRemoveAmount (SOAP V2)</li>
</ul>


<p>Allows you to remove store credit amount from the shopping cart (quote) and increase the customer store credit.</p>

<p><b>Arguments:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string </td>
<td> quoteId </td>
<td> Shopping cart ID (quote ID) </td>
</tr>
<tr>
<td> string </td>
<td> store </td>
<td> Store view code or ID (optional) </td>
</tr>
</tbody></table>


<p><b>Return:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Description </th>
</tr>
<tr>
<td> boolean </td>
<td> Result of removing the amount </td>
</tr>
</tbody></table>


<p><b>Faults:</b></p>


<table><tbody>
<tr>
<th> Fault Code </th>
<th> Fault Message </th>
</tr>
<tr>
<td> 100 </td>
<td> Provided data is invalid. </td>
</tr>
<tr>
<td> 103 </td>
<td> No quote found with requested id. </td>
</tr>
<tr>
<td> 104 </td>
<td> Store credit can not be used for quote created by guest. </td>
</tr>
<tr>
<td> 105 </td>
<td> No store found with requested id or code. </td>
</tr>
</tbody></table>


<h4><a name="storecredit_quote.removeAmount-Examples"></a>Examples</h4>

<h5><a name="storecredit_quote.removeAmount-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy-&gt;login('apiUser', 'apiKey');
$quoteId = 15;

$balanceAmountUsedInQuote = $proxy-&gt;call($sessionId, 'storecredit_quote.removeAmount', array($quoteId));</pre>
		</div>
</div></div>

<h5><a name="storecredit_quote.removeAmount-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;shoppingCartCustomerbalanceRemoveAmount($sessionId, '15');
var_dump($result);</pre>
		</div>
</div></div>




<h5><a name="storecredit_quote.removeAmount-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey')); 
 
$result = $proxy-&gt;shoppingCartCustomerbalanceRemoveAmount((object)array('sessionId' =&gt; $sessionId-&gt;result, 'quoteId' =&gt; '15', 'store' =&gt; null));   
var_dump($result-&gt;result);</pre>
		</div>
</div></div>



